Add README for each example #1199
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive README documentation for each example directory, providing users with clear instructions, purposes, and code snippets for running and understanding the examples.
- Introduce README files for all example categories (topics, services, rosidl, rate, parameter, lifecycle, graph, actions)
- Detail purpose, functionality, features, run commands, and expected outputs for each example
- Include key concepts, troubleshooting tips, and advanced patterns in the documentation
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| example/topics/README.md | Added overview and usage instructions for topic examples |
| example/services/README.md | Added overview and usage instructions for service examples |
| example/rosidl/README.md | Added examples of ROSIDL parsing with explanations |
| example/rate/README.md | Added rate control example documentation |
| example/parameter/README.md | Added parameter handling example documentation |
| example/lifecycle/README.md | Added lifecycle node example with state machine details |
| example/graph/README.md | Added graph introspection examples and sample output |
| example/actions/README.md | Added action client and server example documentation |
Comments suppressed due to low confidence (4)
example/graph/README.md:101
- [nitpick] Including comments (// ...) inside a code block for sample output may confuse readers. Consider replacing it with an ellipsis (...) or explanatory text outside the fenced block.
// ... other built-in node services
example/graph/README.md:117
- [nitpick] The 'CLIENTS BY NODE' sample output structure is inconsistent with the 'PUBLISHERS BY NODE' and 'SUBSCRIPTIONS BY NODE' sections, which group entries by node. Consider aligning the client output to include node identifiers and an info array for clarity.
{
example/rate/README.md:94
- [nitpick] The example command omits the leading slash on the topic name. For consistency with ROS 2 conventions, it should be
ros2 topic echo /topic std_msgs/msg/String.
ros2 topic echo topic std_msgs/msg/String
example/lifecycle/README.md:184
- The example references this._StateInterface, which isn't defined. It should use the correct lifecycle state reference, for example rclnodejs.lifecycle.State.PRIMARY_STATE or import the appropriate StateInterface.
if (prevState.id === this._StateInterface.PRIMARY_STATE) {
minggangw
added a commit
that referenced
this pull request
Jul 22, 2025
This PR adds comprehensive README documentation for each example directory, providing users with clear instructions, purposes, and code snippets for running and understanding the examples. - Introduce README files for all example categories (topics, services, rosidl, rate, parameter, lifecycle, graph, actions) - Detail purpose, functionality, features, run commands, and expected outputs for each example - Include key concepts, troubleshooting tips, and advanced patterns in the documentation Fix: #1198
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds comprehensive README documentation for each example directory, providing users with clear instructions, purposes, and code snippets for running and understanding the examples.
Fix: #1198